Interface AcsServerProcess

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
AcsServerProcessImpl

public interface AcsServerProcess extends Process
Information provided by the PKI file:

    \class AcsServerProcess
    
    \brief AcsServerProcess holds and manipulates the ACS server process.
    
    \example network().getDevice("Router0").getProcess("AcsServer")
    
Author:
Auto-generated
  • Method Details

    • addToUserMap

      boolean addToUserMap(String userName, String description, String password)
      Information provided by the PKI file:
      
          \brief Adds a user record with the specified username, description, and password.
          
          \param userName, the username of the user record to add.
          \param description, the description of the user record to add.
          \param password, the password of the user record to add.
          
          \return bool, true if user record added successfully, otherwise false.
          
              
      Parameters:
      userName - Takes in a parameter of userName
      description - Takes in a parameter of description
      password - Takes in a parameter of password
      Returns:
      boolean Returns a boolean
    • deleteFromUserMap

      void deleteFromUserMap(String userName)
      Information provided by the PKI file:
      
          \brief Removes the user record with the specified username, description, and password.
          
          \param userName, the username of the user record to remove.
          
              
      Parameters:
      userName - Takes in a parameter of userName
    • addToClientMap

      boolean addToClientMap(IPAddress hostIp, AcsServerType serverType, String name, String keyStr)
      Information provided by the PKI file:
      
          \brief Adds a client with the specified IP address, server type, name, and password.
          
          \param hostIp, the IP address of the client.
          \param serverType,  the type of server.
          Server types:       eTacacsServer = 0,
          eRadiusServer = 1
          \param name, the name of the client.
          \param keyStr, the secret key for the client.
          
          \return bool, true if client added successfully, otherwise false.
          
              
      Parameters:
      hostIp - Takes in a parameter of hostIp
      serverType - Takes in a parameter of serverType
      name - Takes in a parameter of name
      keyStr - Takes in a parameter of keyStr
      Returns:
      boolean Returns a boolean
    • deleteFromClientMap

      void deleteFromClientMap(IPAddress hostIp, AcsServerType serverType)
      Information provided by the PKI file:
      
          \brief Removes the client with the specified username, description, and password.
          
          \param hostIp, the IP address of the client.
          \param serverType,  the type of server.
          Server types:       eTacacsServer = 0,
          eRadiusServer = 1
          \param name, the name of the client.
          \param keyStr, the secret key for the client.
          
          \return bool, true if client removed successfully, otherwise false.
          
              
      Parameters:
      hostIp - Takes in a parameter of hostIp
      serverType - Takes in a parameter of serverType
    • enableACSServerService

      void enableACSServerService(boolean status)
      Information provided by the PKI file:
      
          \brief Removes the client with the specified username, description, and password.
          
          \param status, true enables the ACS service, false disables it.
          
              
      Parameters:
      status - Takes in a parameter of status
    • isEnabled

      boolean isEnabled()
      Information provided by the PKI file:
      
          \brief Returns true if the ACS service is enabled, otherwise false.
          
          \return bool, true if the ACS service is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getUserRecordsAsString

      List<String> getUserRecordsAsString()
      Information provided by the PKI file:
      
          \brief Returns a vector of all user records in string format:
          key:username,password,description
          
          \return Returns a vector of all user records in string format:
          key:username,password,description
          
              
      Returns:
      List<String> Returns a List<String>
    • getClientRecordsAsString

      List<String> getClientRecordsAsString()
      Information provided by the PKI file:
      
          \brief Returns a vector of all client records in string format:
          key:username,password,description
          
          \return Returns a vector of all user records in string format:
          key:description,server_type_as_integer,hostip,keystring
          Server type = eTacacsServer=0,
          Server type = eRadiusServer=1
          
              
      Returns:
      List<String> Returns a List<String>
    • removeAllUserRecords

      void removeAllUserRecords()
    • removeAllClientRecords

      void removeAllClientRecords()